Skip to content

MINOR: Add release process document#3089

Merged
Ethanlm merged 1 commit intoapache:masterfrom
srdo:minor-add-release-process-doc
Jul 19, 2019
Merged

MINOR: Add release process document#3089
Ethanlm merged 1 commit intoapache:masterfrom
srdo:minor-add-release-process-doc

Conversation

@srdo
Copy link
Contributor

@srdo srdo commented Jul 18, 2019

This is adapted from Taylor's description of how to release. I think we should have a document like this in the repo. Suggestions are welcome.

@srdo srdo force-pushed the minor-add-release-process-doc branch from 70482c1 to 6493b4f Compare July 18, 2019 20:51
Copy link
Contributor

@Ethanlm Ethanlm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the documentation. This is really useful.

Left some minor comments

RELEASING.md Outdated
@@ -0,0 +1,58 @@
# Developer documentation
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This can be "Committer documentation" or something similar

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice catch, thanks

RELEASING.md Outdated

1. Run `mvn release:prepare` followed `mvn release:perform` on the branch to be released. This will create all the artifacts that will eventually be available in maven central. This step may seem simple, but a lot can go wrong (mainly flaky tests).

2. Once you get a successful maven release, a “staging repository” will be created at http://repository.apache.org in the “open” state, meaning it is still writable. You will need to close it, making it read-only. You can find more information on this step [here]{www.apache.org/dev/publishing-maven-artifacts.html}.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[here]{www.apache.org/dev/publishing-maven-artifacts.html}. seems wrong. It needs to be "()" instead of "{}"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good eyes, fixed

Copy link
Contributor

@Ethanlm Ethanlm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

Copy link
Contributor

@HeartSaVioR HeartSaVioR left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The content doesn't seem to be "no-brainer", but there seems to have enough links to cover the necessary knowledges.

Thanks @srdo for dealing with missing one. Thanks @ptgoetz for kindly sharing the steps in mailing thread.

+1

@srdo srdo force-pushed the minor-add-release-process-doc branch from 8e0615f to 0ade48d Compare July 19, 2019 16:50
@srdo
Copy link
Contributor Author

srdo commented Jul 19, 2019

Whoops, forgot to exclude the new file from RAT. Fixed this and squashed.

Copy link
Contributor

@Ethanlm Ethanlm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

still +1

@Ethanlm Ethanlm merged commit 0114323 into apache:master Jul 19, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants